/**
 * SpringDoc OpenAPI 配置类
 *
 * 功能概述：
 * • 配置SpringDoc OpenAPI文档生成
 * • 定义API文档元数据和版权信息
 * • 提供外部文档链接引用
 *
 * 配置内容：
 * • API文档标题、描述和版本信息
 * • 开源协议信息（Apache 2.0）
 * • 外部文档资源链接
 *
 * 生成效果：
 * • 自动生成REST API交互式文档
 * • 支持在线API测试和调试
 * • 提供API模型定义和参数说明
 *
 * 访问地址：
 * • Swagger UI: http://host:port/swagger-ui.html
 * • API Docs: http://host:port/v3/api-docs
 */
package com.example.mangroves.config;

import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SpringDocConfig {

    /**
     * 配置OpenAPI文档信息
     *
     * @return OpenAPI配置实例
     */
    @Bean
    public OpenAPI restfulOpenAPI() {
        return new OpenAPI()
                .info(new Info().title("红树林在线监测系统 API")
                        .description("Vorticity Data Monitoring")
                        .version("v0.0.1")
                        .license(new License().name("Apache 2.0").url("http://springdoc.org")))
                .externalDocs(new ExternalDocumentation()
                        .description("SpringDoc Documentation")
                        .url("https://springdoc.org/v2"));
    }
}